<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>TrayTip</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<link href="../static/theme.css" rel="stylesheet" type="text/css" />
<script src="../static/content.js" type="text/javascript"></script>
</head>
<body>

<h1>TrayTip</h1>

<p>Creates a balloon message window near the tray icon.</p>

<pre class="Syntax">TrayTip [, Title, Text, Seconds, Options]</pre>
<h3>Parameters</h3>
<dl>

  <dt>Title</dt>
  <dd><p>If all parameters are omitted, any TrayTip window currently displayed will be removed.</p>
    <p>Otherwise, this parameter is the title of the window, which can be up to 73 characters long (characters beyond this length are not shown).</p>
    <p>If <em>Title</em> is blank, the title line will be entirely omitted from the balloon window, making it vertically shorter.</p></dd>

  <dt>Text</dt>
  <dd><p>If this parameter is omitted or blank, any TrayTip window currently displayed will be removed.</p>
      <p>Otherwise, specify the message to display, which appears beneath <em>Title</em>. Only the first 265 characters of <em>Text</em> will be displayed. Carriage return (`r) or linefeed (`n) may be used to create multiple lines of text. For example: <code>Line1`nLine2</code>.</p>
      <p>If <em>Text</em> is long, it can be broken up into several shorter lines by means of a <a href="../Scripts.htm#continuation">continuation section</a>, which might improve readability and maintainability.</p>
    </dd>

  <dt>Seconds</dt>
  <dd><p>The approximate number of seconds to display the window, after which it will be automatically removed by the OS. Specifying a number less than 10 or greater than 30 will usually cause the minimum (10) or maximum (30) display time to be used instead. If blank or omitted, the minimum time will usually be used. This parameter can be an <a href="../Variables.htm#Expressions">expression</a>.</p>
    <p>The actual timeout may vary from the one specified. Microsoft explains, &quot;if the user does not appear to be using the computer, the system does not count this time towards the timeout.&quot; (Technical details <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/shellcc/platform/shell/reference/structures/notifyicondata.asp">here</a>). Therefore, to have precise control over how long the TrayTip is displayed, use the <a href="Sleep.htm">Sleep</a> command followed by TrayTip with no parameters, or use <a href="SetTimer.htm">SetTimer</a> as illustrated in the Examples section below.</p>
    </dd>

  <dt>Options</dt>
  <dd><p>The <em>Options</em> parameter can be a combination (sum) of zero or more of the following values:</p>
    <table class="info">
      <tr><th>Function</th><th>Decimal Value</th><th>Hex Value</th></tr>
      <tr><td>Info icon</td><td>1</td><td>0x1</td></tr>
      <tr><td>Warning icon</td><td>2</td><td>0x2</td></tr>
      <tr><td>Error icon</td><td>3</td><td>0x3</td></tr>
      <tr><td>Windows XP and later: Do not play the notification sound.</td><td>16</td><td>0x10</td></tr>
      <tr><td>Windows Vista and later: Use the large version of the icon.</td><td>32</td><td>0x20</td></tr>
    </table>
    <p>If omitted, it defaults to 0, which is no icon. The icon is also not shown if <em>Title</em> is omitted.</p>
    <p>This parameter can be an <a href="../Variables.htm#Expressions">expression</a>.</p>
    </dd>

</dl>
<h3>Remarks</h3>
<p>The TrayTip balloon window cannot be shown if the script lacks a tray icon (via <a href="_NoTrayIcon.htm">#NoTrayIcon</a> or <code><a href="Menu.htm">Menu</a>, tray, NoIcon</code>). Similarly, if the following REG_DWORD value exists and has been set to 0, TrayTip will not function:</p>
<pre>HKCU\Software\Microsoft\Windows\CurrentVersion\Explorer\Advanced &gt;&gt; EnableBalloonTips</pre>
<p>On a related note, there is a tooltip displayed whenever the user hovers the mouse over the script's tray icon. The contents of this tooltip can be changed via: <code><a href="Menu.htm">Menu</a>, Tray, Tip, My New Text</code>.</p>
<h3>Related</h3>
<p><a href="ToolTip.htm">ToolTip</a>, <a href="SetTimer.htm">SetTimer</a>, <a href="Menu.htm">Menu</a>, <a href="SplashTextOn.htm">SplashTextOn</a>, <a href="MsgBox.htm">MsgBox</a>, <a href="InputBox.htm">InputBox</a>, <a href="FileSelectFile.htm">FileSelectFile</a>, <a href="FileSelectFolder.htm">FileSelectFolder</a></p>
<h3>Examples</h3>
<pre class="NoIndent">TrayTip, My Title, Multiline`nText, 20, 17

<em>; To have more precise control over the display time without
; having to use Sleep (which stops the current thread):</em>
#Persistent
TrayTip, Timed TrayTip, This will be displayed for 5 seconds.
SetTimer, RemoveTrayTip, 5000
return

RemoveTrayTip:
SetTimer, RemoveTrayTip, Off
TrayTip
return

<em>; To have a TrayTip permanently displayed, use a timer to refresh it periodically:</em>
SetTimer, RefreshTrayTip, 1000
Gosub, RefreshTrayTip  <em>; Call it once to get it started right away.</em>
return

RefreshTrayTip:
TrayTip, Refreshed TrayTip, This is a more permanent TrayTip., , 16
return</pre>

</body>
</html>
